package com.star.common.orm.repository;


import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.star.common.orm.entity.Model;
import com.star.common.orm.entity.Page;
import com.star.common.orm.entity.QueryParam;

import java.io.Serializable;
import java.util.List;

/**
 * 基础数据库操作类 基础service接口层要implement当前接口
 *
 * @author zhouhengzhe
 */
public interface BaseRepository<M extends Model, Q extends QueryParam> {

    /**
     * 获取mapper对象
     *
     * @param <MP>
     * @return
     */
    <MP extends BaseMapper> MP getMapper();

    /**
     * 保存
     *
     * @param model 参数
     * @return 成功/失败
     */
    boolean save(M model);

    /**
     * 批量保存
     *
     * @param models
     * @return
     */
    boolean save(List<? extends Model> models);

    /**
     * 更新
     *
     * @param model
     * @return
     */
    boolean update(M model);

    /**
     * 根据条件更新
     *
     * @param model 模型
     * @param param 参数
     * @return
     */
    boolean update(M model, Q param);


    /**
     * 批量更新
     *
     * @param list
     * @return
     */
    boolean update(List<? extends Model> list);

    /**
     * 保存或者更新
     *
     * @param model
     * @return
     */
    boolean saveOrUpdate(M model);

    /**
     * 根据ID删除
     *
     * @param id 主键ID
     * @return
     */
    boolean delete(Serializable id);

    /**
     * 根据参数删除
     *
     * @param param
     * @return
     */
    boolean delete(Q param);

    /**
     * 批量删除
     *
     * @param ids
     * @return
     */
    boolean delete(List<? extends Serializable> ids);

    /**
     * 根据业务key删除，需要配合@BizKey
     *
     * @param key
     * @return
     */
    boolean deleteByKey(Serializable key);

    /**
     * 多个业务key删除
     *
     * @param keys
     * @return
     */
    boolean deleteByKeys(List<Serializable> keys);

    /**
     * 根据ID集合批量查询
     *
     * @param ids
     * @return
     */
    List<M> list(List<? extends Serializable> ids);

    /**
     * 根据参数批量查询
     *
     * @param param
     * @return
     */
    List<M> list(Q param);

    /**
     * 根据参数查询第一个数据
     *
     * @param param
     * @return
     */
    M first(Q param);

    /**
     * 根据参数获取一个
     *
     * @param param
     * @return
     */
    M getOne(Q param);

    /**
     * 根据主键ID获取一条数据
     *
     * @param id
     * @return
     */
    M get(Serializable id);

    /**
     * 统计
     *
     * @param param
     * @return
     */
    long count(Q param);

    /**
     * 是否存在
     *
     * @param param 参数
     * @return
     */
    boolean exist(Q param);

    /**
     * 根据参数分页查询
     *
     * @param param
     * @return
     */
    Page<M> page(Q param);

    /**
     * 通过业务key更新
     *
     * @param model
     * @return
     */
    boolean updateByKey(M model);

    /**
     * 根据业务key批量更新
     *
     * @param models
     * @return
     */
    boolean updateByKey(List<? extends Model> models);

    /**
     * 根据业务key获取数据
     *
     * @param key
     * @return
     */
    M getByKey(String key);

    /**
     * 根据业务key批量查询
     *
     * @param keys
     * @return
     */
    List<M> listByKey(List<Serializable> keys);

    /**
     * 填充数据
     *
     * @param param
     * @param models
     */
    void fill(Q param, List<M> models);
}
